Catalyst / admin/Strike 14.8 GB / 57.8 GB 40.0 GB free
Help Sign in

admin / Strike

public

Web-Based UK Cyber Compliance Tool with Reporting

Code Issues Pull requests Pipelines Packages Security Insights Wiki Settings
Strike / StrikeXi v3 / backend / app / models.py 12265 B · main 
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
import uuid
from datetime import datetime, date

from sqlalchemy import (
    String, Text, Boolean, Integer, Numeric, ForeignKey, DateTime, Date, BigInteger
)
from sqlalchemy.dialects.postgresql import UUID, JSONB
from sqlalchemy.orm import relationship, mapped_column, Mapped
from sqlalchemy.sql import func

from .database import Base


def _uuid():
    return uuid.uuid4()


class Framework(Base):
    """A self-contained maturity framework (e.g. CAF, CSRB). v3."""
    __tablename__ = "frameworks"
    id: Mapped[str] = mapped_column(String, primary_key=True)
    name: Mapped[str] = mapped_column(Text, nullable=False)
    description: Mapped[str] = mapped_column(Text, nullable=True)
    version: Mapped[str] = mapped_column(Text, nullable=True)
    sort_order: Mapped[int] = mapped_column(Integer, default=0)
    is_active: Mapped[bool] = mapped_column(Boolean, default=True, nullable=False)


class User(Base):
    __tablename__ = "users"
    id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), primary_key=True, default=_uuid)
    username: Mapped[str] = mapped_column(String, unique=True, nullable=False)
    password_hash: Mapped[str] = mapped_column(Text, nullable=False)
    full_name: Mapped[str] = mapped_column(Text, nullable=True)
    role: Mapped[str] = mapped_column(String, default="assessor", nullable=False)
    is_active: Mapped[bool] = mapped_column(Boolean, default=True, nullable=False)
    must_change_password: Mapped[bool] = mapped_column(Boolean, default=False, nullable=False)
    mfa_secret: Mapped[str] = mapped_column(Text, nullable=True)
    mfa_enabled: Mapped[bool] = mapped_column(Boolean, default=False, nullable=False)
    mfa_required: Mapped[bool] = mapped_column(Boolean, default=False, nullable=False)
    # V2 self-service signup profile fields
    first_name: Mapped[str] = mapped_column(Text, nullable=True)
    surname: Mapped[str] = mapped_column(Text, nullable=True)
    company_name: Mapped[str] = mapped_column(Text, nullable=True)
    email: Mapped[str] = mapped_column(Text, nullable=True)
    contact_number: Mapped[str] = mapped_column(Text, nullable=True)
    # 'self_service' (public signup) or 'admin' (created by an administrator)
    signup_origin: Mapped[str] = mapped_column(String, default="admin", nullable=False)
    # True until the account's first successful login; drives first-login MFA enrolment.
    first_login_pending: Mapped[bool] = mapped_column(Boolean, default=False, nullable=False)
    created_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), server_default=func.now())
    updated_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), server_default=func.now(), onupdate=func.now())
    last_login: Mapped[datetime] = mapped_column(DateTime(timezone=True), nullable=True)


class CafObjective(Base):
    # v3: generic "framework objective" (top taxonomy level), scoped by framework.
    __tablename__ = "caf_objectives"
    id: Mapped[str] = mapped_column(String, primary_key=True)
    framework_id: Mapped[str] = mapped_column(String, ForeignKey("frameworks.id"),
                                              default="caf", nullable=False)
    title: Mapped[str] = mapped_column(Text, nullable=False)
    description: Mapped[str] = mapped_column(Text, nullable=True)
    sort_order: Mapped[int] = mapped_column(Integer, default=0)


class CafPrinciple(Base):
    # v3: generic "framework principle" (second taxonomy level).
    __tablename__ = "caf_principles"
    id: Mapped[str] = mapped_column(String, primary_key=True)
    framework_id: Mapped[str] = mapped_column(String, ForeignKey("frameworks.id"),
                                              default="caf", nullable=False)
    objective_id: Mapped[str] = mapped_column(String, ForeignKey("caf_objectives.id"))
    title: Mapped[str] = mapped_column(Text, nullable=False)
    description: Mapped[str] = mapped_column(Text, nullable=True)
    sort_order: Mapped[int] = mapped_column(Integer, default=0)


class Question(Base):
    __tablename__ = "questions"
    id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), primary_key=True, default=_uuid)
    principle_id: Mapped[str] = mapped_column(String, ForeignKey("caf_principles.id"))
    code: Mapped[str] = mapped_column(String, unique=True, nullable=False)
    text: Mapped[str] = mapped_column(Text, nullable=False)
    guidance: Mapped[str] = mapped_column(Text, nullable=True)
    weight: Mapped[float] = mapped_column(Numeric(5, 2), default=1.0)
    sort_order: Mapped[int] = mapped_column(Integer, default=0)
    options = relationship("AnswerOption", backref="question", cascade="all, delete-orphan")


class AnswerOption(Base):
    __tablename__ = "answer_options"
    id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), primary_key=True, default=_uuid)
    question_id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), ForeignKey("questions.id", ondelete="CASCADE"))
    label: Mapped[str] = mapped_column(Text, nullable=False)
    score: Mapped[float] = mapped_column(Numeric(4, 3), nullable=False)
    sort_order: Mapped[int] = mapped_column(Integer, default=0)


class RemediationSuggestion(Base):
    __tablename__ = "remediation_suggestions"
    id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), primary_key=True, default=_uuid)
    title: Mapped[str] = mapped_column(Text, nullable=False)
    detail: Mapped[str] = mapped_column(Text, nullable=False)
    priority: Mapped[int] = mapped_column(Integer, default=3)
    effort: Mapped[str] = mapped_column(String, default="medium")


class RemediationMapping(Base):
    __tablename__ = "remediation_mappings"
    id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), primary_key=True, default=_uuid)
    principle_id: Mapped[str] = mapped_column(String, ForeignKey("caf_principles.id"))
    remediation_id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), ForeignKey("remediation_suggestions.id"))
    threshold: Mapped[float] = mapped_column(Numeric(4, 3), default=0.700)


class Assessment(Base):
    __tablename__ = "assessments"
    id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), primary_key=True, default=_uuid)
    user_id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), ForeignKey("users.id"))
    framework_id: Mapped[str] = mapped_column(String, ForeignKey("frameworks.id"),
                                              default="caf", nullable=False)
    organisation_name: Mapped[str] = mapped_column(Text, nullable=False)
    assessment_date: Mapped[date] = mapped_column(Date, default=date.today)
    status: Mapped[str] = mapped_column(String, default="in_progress")
    overall_score: Mapped[float] = mapped_column(Numeric(5, 2), nullable=True)
    created_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), server_default=func.now())
    updated_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), server_default=func.now(), onupdate=func.now())
    answers = relationship("AssessmentAnswer", backref="assessment", cascade="all, delete-orphan")
    principle_scores = relationship("AssessmentPrincipleScore", backref="assessment", cascade="all, delete-orphan")
    objective_scores = relationship("AssessmentObjectiveScore", backref="assessment", cascade="all, delete-orphan")
    actions = relationship("RemediationAction", backref="assessment", cascade="all, delete-orphan")
    evidence = relationship("AssessmentEvidence", backref="assessment", cascade="all, delete-orphan")
    revisions = relationship("AssessmentRevision", backref="assessment", cascade="all, delete-orphan")


class AssessmentAnswer(Base):
    __tablename__ = "assessment_answers"
    id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), primary_key=True, default=_uuid)
    assessment_id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), ForeignKey("assessments.id", ondelete="CASCADE"))
    question_id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), ForeignKey("questions.id"))
    option_id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), ForeignKey("answer_options.id"))


class AssessmentPrincipleScore(Base):
    __tablename__ = "assessment_principle_scores"
    id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), primary_key=True, default=_uuid)
    assessment_id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), ForeignKey("assessments.id", ondelete="CASCADE"))
    principle_id: Mapped[str] = mapped_column(String, ForeignKey("caf_principles.id"))
    score: Mapped[float] = mapped_column(Numeric(5, 2), nullable=False)


class AssessmentObjectiveScore(Base):
    __tablename__ = "assessment_objective_scores"
    id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), primary_key=True, default=_uuid)
    assessment_id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), ForeignKey("assessments.id", ondelete="CASCADE"))
    objective_id: Mapped[str] = mapped_column(String, ForeignKey("caf_objectives.id"))
    score: Mapped[float] = mapped_column(Numeric(5, 2), nullable=False)


class RemediationAction(Base):
    __tablename__ = "remediation_actions"
    id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), primary_key=True, default=_uuid)
    assessment_id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), ForeignKey("assessments.id", ondelete="CASCADE"))
    principle_id: Mapped[str] = mapped_column(String, ForeignKey("caf_principles.id"))
    remediation_id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), ForeignKey("remediation_suggestions.id"))
    principle_score: Mapped[float] = mapped_column(Numeric(5, 2), nullable=False)
    status: Mapped[str] = mapped_column(String, default="queued")
    external_ref: Mapped[str] = mapped_column(Text, nullable=True)
    external_system: Mapped[str] = mapped_column(Text, nullable=True)
    created_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), server_default=func.now())


class AssessmentEvidence(Base):
    """Evidence/notes attached to an assessment (v3). question_id NULL = assessment-level."""
    __tablename__ = "assessment_evidence"
    id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), primary_key=True, default=_uuid)
    assessment_id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), ForeignKey("assessments.id", ondelete="CASCADE"))
    question_id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), ForeignKey("questions.id"), nullable=True)
    kind: Mapped[str] = mapped_column(String, default="note", nullable=False)  # note | evidence
    content: Mapped[str] = mapped_column(Text, nullable=True)
    file_name: Mapped[str] = mapped_column(Text, nullable=True)
    file_path: Mapped[str] = mapped_column(Text, nullable=True)
    mime_type: Mapped[str] = mapped_column(Text, nullable=True)
    file_size: Mapped[int] = mapped_column(BigInteger, nullable=True)
    created_by: Mapped[str] = mapped_column(Text, nullable=False)
    created_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), server_default=func.now())


class AssessmentRevision(Base):
    """Immutable score+answer snapshot taken each time an assessment is scored (v3)."""
    __tablename__ = "assessment_revisions"
    id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), primary_key=True, default=_uuid)
    assessment_id: Mapped[uuid.UUID] = mapped_column(UUID(as_uuid=True), ForeignKey("assessments.id", ondelete="CASCADE"))
    revision_no: Mapped[int] = mapped_column(Integer, nullable=False)
    label: Mapped[str] = mapped_column(Text, nullable=True)
    overall_score: Mapped[float] = mapped_column(Numeric(5, 2), nullable=True)
    snapshot: Mapped[dict] = mapped_column(JSONB, nullable=False)
    triggered_by: Mapped[str] = mapped_column(Text, nullable=False)
    created_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), server_default=func.now())


class AuditLog(Base):
    __tablename__ = "audit_log"
    id: Mapped[int] = mapped_column(BigInteger, primary_key=True, autoincrement=True)
    ts: Mapped[datetime] = mapped_column(DateTime(timezone=True), server_default=func.now())
    username: Mapped[str] = mapped_column(Text, nullable=True)
    action: Mapped[str] = mapped_column(Text, nullable=False)
    detail: Mapped[str] = mapped_column(Text, nullable=True)
    ip_address: Mapped[str] = mapped_column(Text, nullable=True)